home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 1996 December / Software of the Month Club 1996 December.iso / pc / dos / dtp / autohtml / autohtml.doc next >
Text File  |  1996-10-10  |  8KB  |  213 lines
  1.                                AUTOHTML
  2.  
  3.                               Version 5.2
  4.  
  5.  
  6.  
  7. Overview:
  8.  
  9. AUTOHTML creates a multi-page web site from text source files in the 
  10. current directory. The first page is always called TOC.HTML and is a 
  11. table of contents linking to the other pages. 
  12.  
  13. A page is created for each source file. If the defaults are selected, 
  14. a separate table of contents file will be created for each page, with 
  15. the name tocxxxxx.htm where xxxxx is the last five characters of the 
  16. source file name.
  17.  
  18. The title for the first page is received from the command line as a 
  19. parameter supplied to AUTOHTML.EXE. Enclose this text within speech 
  20. marks, or only the first word will be picked up! Each entry in the 
  21. first page (TOC.HTML) is derived from a single text line in a file 
  22. with the same name as the source file, but with the extension .TIT 
  23. (short for title). If a TIT file can not be located in the current 
  24. directory, the source file name is used. This title is also used to 
  25. head the source web page and any table of contents page for that 
  26. source file. 
  27.  
  28. Links are automaticaly created whenever a word refers to another item 
  29. heading in any of the source pages. Multiple links to the same topic 
  30. within a section can be supressed with the "duplicate links=no" 
  31. setting in autohtml.ini.
  32.  
  33. An alphabetical global index (gi.htm) is created providing links to 
  34. all topics in all files processed. 
  35.  
  36. Source Files:
  37.  
  38. Source files follow the KNB format; Simply these are comprised of an 
  39. item heading line prefixed by an asterisk, thus: 
  40.  
  41. *This is an item heading
  42.  
  43. followed by any number of lines of text which comprise that item's 
  44. data.
  45.  
  46. To force a link to a multiple word heading, replace spaces with under 
  47. bars (_) within the item data, for example:
  48.  
  49. This example will link with Greater_London.
  50.  
  51. A collection of KNB text files relating to mythology are supplied as 
  52. an example.
  53.  
  54.  
  55. Command Line:
  56.  
  57.         AUTOHTML "Title For First Page"
  58.  
  59.  
  60. Automatic Links:
  61.  
  62. Automatic links will only ever be made to the current page or to the 
  63. first source file, in alphabetical order, containing a reference to 
  64. the item. You can force other files to be linked first by so naming 
  65. them as to be alphabetically earlier. Eg; a file 'AAA.TXT' will be 
  66. scanned before a file called 'BAA.TXT'. For example. If the title 
  67. PARIS occurs in the current page and in another page, a link will be 
  68. made to the current page reference for PARIS. If however, the title 
  69. PARIS occurs in three pages, but not in the current page, then a link 
  70. will be made to the reference PARIS in the page named first.
  71.  
  72. Table Of Contents:
  73.  
  74. The format of each table of contents is either a list, or a table. 
  75. Defined by toc table=yes or toc table=no in autohtml.ini. If a tabular 
  76. format table of contents is required, the number of columns, border 
  77. and cell spacing information is read from the autohtml.ini file. 
  78. Otherwise these parameters are ignored.
  79.  
  80.  
  81. Limitations:
  82.  
  83. AUTOHTML will not create graphical systems. It is designed to carry 
  84. out the donkey work of linking multiple machine-readable text files 
  85. into a fully linked web site. If you want in-line graphics, forms, 
  86. links to other URLs and so on then you will have to add these your 
  87. self.
  88.  
  89.  
  90. AUTOHTML.INI:
  91.  
  92. AUTOHTML acceses a configuration file (autohtml.ini) in the directory 
  93. where autohtml.exe resides. This configuration file may be amended to 
  94. change the format of the created web site.
  95.  
  96. NB: 
  97. Under Windows 95, autohtml may have trouble locating the required 
  98. autohtml.ini file unless it is present in the current directory.
  99.  
  100. [preferences]
  101. case sensitive=no               (Should links match on case)
  102. separate table of contents=yes  (Table of contents separate to main 
  103.                                  data)
  104. main title font=1               (Font 1-6 for main title)
  105. sub title font=2                (Font 1-6 for subsequent title lines)
  106. toc font=3                      (Font to display table of contents 
  107.                                  entries)
  108. source=knb                      (Source file extension)
  109. toc table=yes                   (Use table format for each table of 
  110.                                  contents) 
  111. columns=3                       (Number of table columns) 
  112. width=100                       (Table width as a % of screen width) 
  113. cellspacing=2                   (Table cell spacing) 
  114. border=10                       (Table border) 
  115. align=left                      (Table cell alignment, left, center or 
  116.                                  right)
  117.  
  118. [item]
  119. title font=2                    (Font 1-6 for item titles)
  120. data font=4                     (Font 1-6 to display item data)
  121. title italic=yes                (Item titles Italic yes or no)
  122. title bold=yes                  (Item titles Bold yes or no)
  123. duplicate links=no              (Whether subsequent links to the same
  124.                                  topic should be made within a 
  125.                                  paragraph)
  126. no recurse=no                   (If no recurse=yes, links to items 
  127.                                  which point straight back to the
  128.                                  calling item are supressed. This
  129.                                  slows processing down a lot, and
  130.                                  is not normally required)
  131.  
  132. advanced=yes                    (Use advanced options. These options
  133.                                  override the title font and data 
  134.                                  font settings above if advanced=yes)
  135. background="space.gif"          (Backgound image)
  136. bg colour="#000000"             (Background colour)
  137. text colour="#FFFFFF"           (Text colour)
  138. link colour="#FFFF00"           (Link colour)
  139. alink colour="#000000"          (ALink colour)
  140. vlink colour="#FFFF00"          (Visited link colour)
  141. title size=5                    (Item title size)
  142. title colour="FF0000"           (Item title colour)
  143. data size=3                     (Item data size)
  144. data colour="F0F0F0"            (Item data colour)
  145.  
  146. [ignore]
  147. ; Any words in this section will not be linked
  148. ; This section may include a maximum of 500 words
  149. A
  150. IN
  151. OF
  152. THE
  153.  
  154. Compatability:
  155.  
  156. AUTOHTML has been tested with NCSA Mosaic, Microsoft Internet Explorer 
  157. and Netscape. 
  158.  
  159.  
  160. Frequently Asked Questions:
  161.  
  162. Q. I only have one source file, autohtml creates four HTML files. How do 
  163.    I get around this?
  164.  
  165. A. Autohtml always creates a primary table of contents HTML file 
  166.    called TOC.HTM and a global index file called GI.HTM. This provides 
  167.    a link to all the source files. If you only have one source file, 
  168.    then you can delete the TOC.HTM file. If you have separate table of 
  169.    contents=yes set in the autohtml.ini configuration file, then two HTML 
  170.    files will be created for each source file. The name of one file will 
  171.    commence TOC and this is the table of contents for the other data file. 
  172.    Rename this table of contents file to TOC.HTM and your web site is 
  173.    done.
  174.  
  175. Q. Autohtml doesn't create any HTML files. What's wrong?
  176.  
  177. A. Autohtml searches the current directory for files with an extension 
  178.    matching the source= setting in the configuration file 
  179.    autohtml.ini. Probably you have an incorrect extension set in the 
  180.    configuration file. Remember, the extension in the source= line 
  181.    does not include a period, eg:
  182.  
  183.                 source=knb
  184.  
  185.  
  186.  
  187. Q. When I try to view the HTML files in Mosaic, Mosaic crashes. Help!
  188.  
  189. A. Mosaic is a rather fragile HTML viewer. Try splitting the source 
  190.    files down into more smaller files. 
  191.  
  192. Q. When I try to run autohtml under Windows, it crashes. What's wrong?
  193.  
  194. A. Windows (and especially Windows 95) has a very poor memory manager. 
  195.    The shareware version of autohtml is best run in DOS mode. The 
  196.    registered version will generally run under Windows with out any 
  197.    problems.
  198.  
  199.  
  200.  
  201.  
  202. (c)1996 Servile Software
  203.  
  204. Servile Software
  205. 5 Longcroft Close
  206. Basingstoke
  207. Hampshire
  208. RG21 8XG
  209.  
  210. WWW     http://www.pins.co.uk/upages/probertm
  211. EMAIL   probertm@pins.co.uk
  212.  
  213.